Методы формирования и последующей выгрузки отчетов в различных форматах
/services/reporting_module/api/reports/get/files-download-url
Метод формирования URL выгрузки заданных файлов из PLM ИС Платформы
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| fileID | string | идентификатор файла, для которого формируется URL выгрузки | нет | |
| archiveName | string | наименование архивного файла, выгружаемого по сформированному URL | нет | |
| forPLM | boolean | признак формирования URL выгрузки для PLM | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/export
Метод синхронного формирования отчёта
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| alias | string | псевдоним | нет | |
| namespace | string | пространство имён | нет | |
| type | string | формат отчёта | нет | PDF, XLS, XLSX, XML, JSON, HTML, CSV, RTF, TXT |
| destinationType | string | тип места назначения выгрузки файла отчёта (допустимые значения: PLM, FILES_SERVICE) | нет | PLM, FILES_SERVICE |
| parameters | string | параметры построения отчёта | нет | |
| locale | string | локализация | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |
/services/reporting_module/api/reports/export/async
Метод асинхронного формирования отчёта
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| alias | string | псевдоним | нет | |
| namespace | string | пространство имён | нет | |
| type | string | формат отчёта | нет | PDF, XLS, XLSX, XML, JSON, HTML, CSV, RTF, TXT |
| destinationType | string | тип места назначения выгрузки файла отчёта (допустимые значения: PLM, FILES_SERVICE) | нет | PLM, FILES_SERVICE |
| parameters | string | параметры построения отчёта | нет | |
| callbackURL | string | URL обратного вызова возврата результата выполнения метода | нет | |
| externalURL | boolean | признак необходимости разрешения URL обратного вызова результата выполнения метода посредством сервиса Discovery ИС Платформы | нет | |
| locale | string | л окализация | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | object | результат работы сервиса прикладной области в случае его успешного завершения | нет | |
| error | ADSErrorSection | |||
| typeInfo | ADSTypeInfoSection |